Interface Options

All Superinterfaces:
IPCObject
All Known Implementing Classes:
OptionsImpl

public interface Options extends IPCObject
Information provided by the PKI file:

    \class Options
    
    \brief Options contains the current running options for the application.
    
    \example appWindow().getActiveFile().getOptions()
    
Author:
Auto-generated
  • Method Details

    • isAnimation

      boolean isAnimation()
      Information provided by the PKI file:
      
          \brief Returns true if animation is enabled, otherwise false.
          
          \return bool, true if animation is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isSound

      boolean isSound()
      Information provided by the PKI file:
      
          \brief Returns true if sound is enabled, otherwise false.
          
          \return bool, true if sound is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isTelephonySound

      boolean isTelephonySound()
      Information provided by the PKI file:
      
          \brief Returns true if telephony sound is enabled, otherwise false.
          
          \return bool, true if telephony sound is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isDockFirst

      boolean isDockFirst()
      Information provided by the PKI file:
      
          \brief Returns true if dock first is enabled, otherwise false.
          
          \remark If dock first is enabled, then dock windows will automatically dock instead of pop up on launch.
          
          \return bool, true if dock first is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isLoggingEnabled

      boolean isLoggingEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if logging is enabled, otherwise false.
          
          \remark Logs the users IOS commands to memory which can be exported to a text file.
          
          \return bool, true if logging is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isPortShown

      boolean isPortShown()
      Information provided by the PKI file:
      
          \brief Returns true if showing of port labels are enabled, otherwise false..
          
          \return bool, true if showing of port labels are enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isPortNotShownOnMouseOver

      boolean isPortNotShownOnMouseOver()
      Information provided by the PKI file:
      
          \brief Returns true if showing of port labels on mouse over is disabled, otherwise false.
          
          \return bool, true if showing of port labels on mouse over is disabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isChallenge_PDUInfo

      boolean isChallenge_PDUInfo()
      Information provided by the PKI file:
      
          \brief Returns true if challenge mode for the PDU info is enabled, otherwise false.
          
          \return bool, true if challenge mode for PDU info is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isDeviceModelShown

      boolean isDeviceModelShown()
      Information provided by the PKI file:
      
          \brief Returns true if displaying the device model names is enabled, otherwise false.
          
          \return bool, true if displaying device model names are enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isLinkLightsShown

      boolean isLinkLightsShown()
      Information provided by the PKI file:
      
          \brief Returns true if displaying the link links are enabled, otherwise false.
          
          \return bool, true if displaying the link lights are enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isAccessible

      boolean isAccessible()
      Information provided by the PKI file:
      
          \brief Returns true if accessibility is enabled, otherwise false.
          
          \remark Accessibility enables screen reader support.
          
          \return bool, true if Accessibility is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isPhysicalTabHidden

      boolean isPhysicalTabHidden()
      Information provided by the PKI file:
      
          \brief Returns true if the Physical tabs in device dialogs are shown is enabled, otherwise false.
          
          \return bool, true if the Physical tabs in device dialogs are shown is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isConfigTabHidden

      boolean isConfigTabHidden()
      Information provided by the PKI file:
      
          \brief Returns true if the Config tabs in device dialogs are shown is enabled, otherwise false.
          
          \return bool, true if the Config tabs in device dialogs are shown is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isCliTabHidden

      boolean isCliTabHidden()
      Information provided by the PKI file:
      
          \brief Returns true if the CLI tabs in device dialogs are shown is enabled, otherwise false.
          
          \return bool, true if the CLI tabs in device dialogs are shown is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isDesktopTabHidden

      boolean isDesktopTabHidden()
      Information provided by the PKI file:
      
          \brief Returns true if the Desktop tabs in device dialogs are shown is enabled, otherwise false.
          
          \return bool, true if the Desktop tabs in device dialogs are shown is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isGuiTabHidden

      boolean isGuiTabHidden()
      Information provided by the PKI file:
      
          \brief Returns true if the GUI tabs in device dialogs are shown is enabled, otherwise false.
          
          \return bool, true if the GUI tabs in device dialogs are shown is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isHideDevModelLabel

      boolean isHideDevModelLabel()
      Information provided by the PKI file:
      
          \brief Returns true if all device model labels are to be hidden, otherwise false.
          
          \return bool, true if all device model labels are to be hidden, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isHideDevLabel

      boolean isHideDevLabel()
      Information provided by the PKI file:
      
          \brief Returns true if all device name labels are to be hidden, otherwise false.
          
          \return bool, true if all device name labels are to be hidden, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isHideQoSStamp

      boolean isHideQoSStamp()
      Information provided by the PKI file:
      
          \brief Returns true if QoS stamps on packets are to be hidden, otherwise false.
          
          \return bool, true if QoS stamps on packets are to be hidden, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isEnableCableLengthEffects

      boolean isEnableCableLengthEffects()
      Information provided by the PKI file:
      
          \brief Returns true if cable length effects are enabled, otherwise false.
          
          \return bool, true if cable length effects are enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isAutoCablingDisabled

      boolean isAutoCablingDisabled()
      Information provided by the PKI file:
      
          \brief Returns true if auto cabling is disabled, otherwise false.
          
          \return bool, true if auto cabling is disabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isUsingMetric

      boolean isUsingMetric()
      Information provided by the PKI file:
      
          \brief Returns true if using Metric System, otherwise false.
          
          \return bool, true if using Metric System, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isDevTaskbarShown

      boolean isDevTaskbarShown()
      Information provided by the PKI file:
      
          \brief Returns true if the device dialog taskbar is shown, otherwise false.
          
          \return bool, true if the device dialog taskbar is shown, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isExternalNetworkAccessEnabled

      boolean isExternalNetworkAccessEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if external network access from device scripts is enabled, otherwise false.
          
          \return bool, true if external network access from device scripts is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isUseCliDefaultTab

      boolean isUseCliDefaultTab()
      Information provided by the PKI file:
      
          \brief Returns true if the CLI tab is the device default tab, otherwise false.
          
          \return bool, true if the CLI tab is the device default tab, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isCableInfoPopup

      boolean isCableInfoPopup()
      Information provided by the PKI file:
      
          \brief Returns true if the cable info popup in Physical Workspace is shown when mouseover on the cable, otherwise false.
          
          \return bool, true if the cable info popup in Physical Workspace is shown when mouseover on the cable, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getConfigFilePath

      String getConfigFilePath()
      Information provided by the PKI file:
      
          \brief Returns the path to the administrative configuration file.
          
          \remark This file is the serialization of the settings in this class.
          
          \return QString, the path to the administrative configuration file.
          
              
      Returns:
      String Returns a String
    • setAnimation

      void setAnimation(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables animation.
          
          \param bEnable, true to enable animation, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setSound

      void setSound(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables sound.
          
          \param bEnable, true to enable sound, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setTelephonySound

      void setTelephonySound(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables telephony sound.
          
          \param bEnable, true to enable telephony sound, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setIsDockFirst

      void setIsDockFirst(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables dock first.
          
          \param bEnable, true to enable dock first, false to disable it.
          
          \remark Enabling dock first will cause all new dockable dialogs to be docked when shown.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setIsLoggingEnabled

      void setIsLoggingEnabled(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables logging.
          
          \param bEnable, true to enable logging, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setIsPortShown

      void setIsPortShown(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the port label visibility.
          
          \param bEnable, true to enable port label visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setPortNotShownOnMouseOver

      void setPortNotShownOnMouseOver(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the port label visibility on mouse over.
          
          \param bEnable, true to enable port label visibility on mouse over, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setIsChallenge_PDUInfo

      void setIsChallenge_PDUInfo(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the Challenge Mode in PDU info.
          
          \param bEnable, true to enable Challenge Mode in PDU info, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setAccessible

      void setAccessible(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables accessibility features.
          
          \param bEnable, true to enable accessibility features, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setIsLinkLightShown

      void setIsLinkLightShown(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables link light visibility.
          
          \param bEnable, true to enable link light visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • addBackgroundImage

      void addBackgroundImage(String location, String filePath)
      Information provided by the PKI file:
      
          \brief Adds a background image file to the list of allowed background images to be used on workspaces.
          
          \param QString location,    the location to associate with the image.
          Locations: Building, City, Custom, Intercity, Logical
          \param QString filePath, the relative path to the file from the application bin folder.
          
              
      Parameters:
      location - Takes in a parameter of location
      filePath - Takes in a parameter of filePath
    • removeBackgroundImage

      void removeBackgroundImage(String filePath)
      Information provided by the PKI file:
      
          \brief Removes the specified background image file from the list of allowed background images to be used on workspaces.
          
          \param QString filePath, the relative path to the file from the application bin folder.
          
              
      Parameters:
      filePath - Takes in a parameter of filePath
    • setPhysicalTabHidden

      void setPhysicalTabHidden(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the Physical tab visibility.
          
          \param bEnable, true to enable Physical tab visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setConfigTabHidden

      void setConfigTabHidden(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the Config tab visibility.
          
          \param bEnable, true to enable Config tab visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setCliTabHidden

      void setCliTabHidden(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the CLI tab visibility.
          
          \param bEnable, true to enable CLI tab visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setDesktopTabHidden

      void setDesktopTabHidden(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the Desktop tab visibility.
          
          \param bEnable, true to enable Desktop tab visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setGuiTabHidden

      void setGuiTabHidden(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the GUI tab visibility.
          
          \param bEnable, true to enable GUI tab visibility, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setHideDevModelLabel

      void setHideDevModelLabel(boolean bEnable, boolean isWorkspaceActive)
      Information provided by the PKI file:
      
          \brief Enables or disables hiding of device model labels.
          
          \param bEnable, true to enable hiding of device model labels, false to disable it.
          \param isWorkspaceActive, true if the workspace is active, false if not.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
      isWorkspaceActive - Takes in a parameter of isWorkspaceActive
    • setHideDevLabel

      void setHideDevLabel(boolean bEnable, boolean isWorkspaceActive)
      Information provided by the PKI file:
      
          \brief Enables or disables hiding of device name labels.
          
          \param bEnable, true to enable hiding of device name labels, false to disable it.
          \param isWorkspaceActive, true if the workspace is active, false if not.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
      isWorkspaceActive - Takes in a parameter of isWorkspaceActive
    • setHideQoSStamp

      void setHideQoSStamp(boolean bEnable, boolean isWorkspaceActive)
      Information provided by the PKI file:
      
          \brief Enables or disables hiding of QoS stamps.
          
          \param bEnable, true to enable hiding of QoS stamps, false to disable it.
          \param isWorkspaceActive, true if the workspace is active, false if not.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
      isWorkspaceActive - Takes in a parameter of isWorkspaceActive
    • setEnableCableLengthEffects

      void setEnableCableLengthEffects(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables cable length effects.
          
          \param bEnable, true to enable cable length effects, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setDisableAutoCabling

      void setDisableAutoCabling(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables auto cabling.
          
          \param bEnable, true to disable auto cabling, false to enable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setUseMetric

      void setUseMetric(boolean bMetric)
      Information provided by the PKI file:
      
          \brief Sets whether to use Metric System.
          
          \param bMetric, true to use Metric System, false to use Imperial System.
          
              
      Parameters:
      bMetric - Takes in a parameter of bMetric
    • setShowDevTaskbar

      void setShowDevTaskbar(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the device taskbar.
          
          \param bEnable, true to enable the device taskbar, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setEnableExternalNetworkAccess

      void setEnableExternalNetworkAccess(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables external network access from all script modules and device scripts.
          
          \param bEnable, true to enable external network access from all script modules and device scripts, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setUseCliDefaultTab

      void setUseCliDefaultTab(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the CLI tab as the default tab.
          
          \param bEnable, true to enable the CLI tab as the default tab, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setCableInfoPopup

      void setCableInfoPopup(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the cable info popup in Physical Workspace when mouseover on the cable.
          
          \param bEnable, true to show the cable info popup in Physical Workspace when mouseover on the cable.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setBufferFullAction

      void setBufferFullAction(BufferFullAction action)
      Information provided by the PKI file:
      
          \brief Sets the Buffer Full Action option to the specified action.
          
          \param action,      the Buffer Full Action.
          Buffer Full Actions:        Prompt = 0,
          AutoClearEventList = 1,
          AutoViewPreviousEvents = 2
          
              
      Parameters:
      action - Takes in a parameter of action
    • getBufferFullAction

      BufferFullAction getBufferFullAction()
      Information provided by the PKI file:
      
          \brief Returns the Buffer Full Action option.
          
          \return BufferFullAction,   the Buffer Full Action.
          Buffer Full Actions:        Prompt = 0,
          AutoClearEventList = 1,
          AutoViewPreviousEvents = 2
          
              
      Returns:
      BufferFullAction Returns a BufferFullAction
    • saveFile

      boolean saveFile(String filename)
      Information provided by the PKI file:
      
          \brief Saves this configuration option to a file.
          
          \param filename, the filename including the path to save to.
          
          \return bool, value is true if the file was saved, false if not.
          
              
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      boolean Returns a boolean
    • getCurrentLanguage

      String getCurrentLanguage()
      Information provided by the PKI file:
      
          \brief Returns the current language.
          
          \return QString, value reperesents the current language.
          
              
      Returns:
      String Returns a String
    • addCustomHideOption

      void addCustomHideOption(String id, String title, boolean defaultValue)
      Information provided by the PKI file:
      
          \brief Adds a custom hide option in the Hide tab of Preferences.
          
          \param id, the ID to use for the option.
          \param title, the title to display for the option.
          \param defaultValue, true to set is as being in affect, false to not be in effect.
          
              
      Parameters:
      id - Takes in a parameter of id
      title - Takes in a parameter of title
      defaultValue - Takes in a parameter of defaultValue
    • setCustomHideOption

      void setCustomHideOption(String id, boolean value)
      Information provided by the PKI file:
      
          \brief Sets a custom hide option in the Hide tab of Preferences.
          
          \param id, the ID of the option to set.
          \param value, true to set is as being in affect, false to not be in effect.
          
              
      Parameters:
      id - Takes in a parameter of id
      value - Takes in a parameter of value
    • getCustomHideOption

      boolean getCustomHideOption(String id, boolean defaultValue)
      Information provided by the PKI file:
      
          \brief Gets a custom hide option in the Hide tab of Preferences.
          
          \param id, the ID of the option to get.
          \param defaultFalue, if the option doesn't exist, the value from this will be returned.
          
          \return bool, value is true if the option is on, false if not.
          
              
      Parameters:
      id - Takes in a parameter of id
      defaultValue - Takes in a parameter of defaultValue
      Returns:
      boolean Returns a boolean
    • isMainToolbarShown

      boolean isMainToolbarShown()
      Returns:
      boolean Returns a boolean
    • isSecondaryToolbarShown

      boolean isSecondaryToolbarShown()
      Returns:
      boolean Returns a boolean
    • isBottomToolbarShown

      boolean isBottomToolbarShown()
      Returns:
      boolean Returns a boolean
    • setMainToolbarShown

      void setMainToolbarShown(boolean in)
      Parameters:
      in - Takes in a parameter of in
    • setSecondaryToolbarShown

      void setSecondaryToolbarShown(boolean in)
      Parameters:
      in - Takes in a parameter of in
    • setBottomToolbarShown

      void setBottomToolbarShown(boolean in)
      Parameters:
      in - Takes in a parameter of in
    • enableAddToRecentFiles

      void enableAddToRecentFiles(boolean enable)
      Information provided by the PKI file:
      
          \brief Enables whether to allow adding to the recent files list in File menu.
          
              
      Parameters:
      enable - Takes in a parameter of enable
    • addRecentFile

      void addRecentFile(String fullpath)
      Information provided by the PKI file:
      
          \brief Adds a file to the recent file list.
          
              
      Parameters:
      fullpath - Takes in a parameter of fullpath